<!DOCTYPE html>
<html lang="en">
  <head>
    <title>ZiwoClient Class Reference</title>
    <link rel="stylesheet" type="text/css" href="../css/jazzy.css" />
    <link rel="stylesheet" type="text/css" href="../css/highlight.css" />
    <meta charset='utf-8'>
    <script src="../js/jquery.min.js" defer></script>
    <script src="../js/jazzy.js" defer></script>
    
  </head>
  <body>
    <a name="//apple_ref/swift/Class/ZiwoClient" class="dashAnchor"></a>
    <a title="ZiwoClient Class Reference"></a>
    <header>
      <div class="content-wrapper">
        <p><a href="../index.html">ZiwoSDK 1.0.0 Docs</a> (91% documented)</p>
      </div>
    </header>
    <div class="content-wrapper">
      <p id="breadcrumbs">
        <a href="../index.html">ZiwoSDK Reference</a>
        <img id="carat" src="../img/carat.png" />
        ZiwoClient Class Reference
      </p>
    </div>
    <div class="content-wrapper">
      <nav class="sidebar">
        <ul class="nav-groups">
          <li class="nav-group-name">
            <a href="../Classes.html">Classes</a>
            <ul class="nav-group-tasks">
              <li class="nav-group-task">
                <a href="../Classes/Agent.html">Agent</a>
              </li>
              <li class="nav-group-task">
                <a href="../Classes/Call.html">Call</a>
              </li>
              <li class="nav-group-task">
                <a href="../Classes/RTCClient.html">RTCClient</a>
              </li>
              <li class="nav-group-task">
                <a href="../Classes/VertoHelpers.html">VertoHelpers</a>
              </li>
              <li class="nav-group-task">
                <a href="../Classes/VertoWebSocket.html">VertoWebSocket</a>
              </li>
              <li class="nav-group-task">
                <a href="../Classes/ZiwoClient.html">ZiwoClient</a>
              </li>
              <li class="nav-group-task">
                <a href="../Classes/ZiwoSDK.html">ZiwoSDK</a>
              </li>
              <li class="nav-group-task">
                <a href="../Classes/ZiwoWebSocket.html">ZiwoWebSocket</a>
              </li>
            </ul>
          </li>
          <li class="nav-group-name">
            <a href="../Enums.html">Enumerations</a>
            <ul class="nav-group-tasks">
              <li class="nav-group-task">
                <a href="../Enums/RTCMessageType.html">RTCMessageType</a>
              </li>
              <li class="nav-group-task">
                <a href="../Enums/SocketEvent.html">SocketEvent</a>
              </li>
              <li class="nav-group-task">
                <a href="../Enums/VertoEvent.html">VertoEvent</a>
              </li>
            </ul>
          </li>
          <li class="nav-group-name">
            <a href="../Extensions.html">Extensions</a>
            <ul class="nav-group-tasks">
              <li class="nav-group-task">
                <a href="../Extensions/Defaults.html">Defaults</a>
              </li>
              <li class="nav-group-task">
                <a href="../Extensions/Defaults/Keys.html">– Keys</a>
              </li>
            </ul>
          </li>
          <li class="nav-group-name">
            <a href="../Protocols.html">Protocols</a>
            <ul class="nav-group-tasks">
              <li class="nav-group-task">
                <a href="../Protocols/RTCClientDelegate.html">RTCClientDelegate</a>
              </li>
              <li class="nav-group-task">
                <a href="../Protocols/RTCMessageBuilderProtocol.html">RTCMessageBuilderProtocol</a>
              </li>
              <li class="nav-group-task">
                <a href="../Protocols/RTCMessageParserProtocol.html">RTCMessageParserProtocol</a>
              </li>
              <li class="nav-group-task">
                <a href="../Protocols/VertoWebSocketDelegate.html">VertoWebSocketDelegate</a>
              </li>
              <li class="nav-group-task">
                <a href="../Protocols/ZiwoClientDelegate.html">ZiwoClientDelegate</a>
              </li>
            </ul>
          </li>
          <li class="nav-group-name">
            <a href="../Structs.html">Structures</a>
            <ul class="nav-group-tasks">
              <li class="nav-group-task">
                <a href="../Structs/RTCAnswerMessage.html">RTCAnswerMessage</a>
              </li>
              <li class="nav-group-task">
                <a href="../Structs/RTCCandidateMessage.html">RTCCandidateMessage</a>
              </li>
              <li class="nav-group-task">
                <a href="../Structs/RTCError.html">RTCError</a>
              </li>
              <li class="nav-group-task">
                <a href="../Structs/RTCMessage.html">RTCMessage</a>
              </li>
              <li class="nav-group-task">
                <a href="../Structs/RTCOfferMessage.html">RTCOfferMessage</a>
              </li>
            </ul>
          </li>
        </ul>
      </nav>
      <article class="main-content">
        <section>
          <section class="section">
            <h1>ZiwoClient</h1>
              <div class="declaration">
                <div class="language">
                  <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">ZiwoClient</span></code></pre>
<pre class="highlight swift"><code><span class="kd">extension</span> <span class="kt">ZiwoClient</span><span class="p">:</span> <span class="kt"><a href="../Protocols/VertoWebSocketDelegate.html">VertoWebSocketDelegate</a></span></code></pre>

                </div>
              </div>
            <p><code>ZiwoClient</code> is the main class of the SDK. Through this class, the websocket that will be used to communicate with Verto will be initialized.
The delegates will tell the developper when a call is received, when a call starts and when a call is terminated. It also provide informations about websocket that is linked to the <code>Verto</code> protocol.</p>

          </section>
          <section class="section task-group-section">
            <div class="task-group">
              <div class="task-name-container">
                <a name="/Verto%20Web%20Socket"></a>
                <a name="//apple_ref/swift/Section/Verto Web Socket" class="dashAnchor"></a>
                <div class="section-name-container">
                  <a class="section-name-link" href="#/Verto%20Web%20Socket"></a>
                  <h3 class="section-name"><p>Verto Web Socket</p>
</h3>
                </div>
              </div>
              <ul>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:7ZiwoSDK0A6ClientC14vertoWebSocketAA05VertoeF0CSgvp"></a>
                    <a name="//apple_ref/swift/Property/vertoWebSocket" class="dashAnchor"></a>
                    <a class="token" href="#/s:7ZiwoSDK0A6ClientC14vertoWebSocketAA05VertoeF0CSgvp">vertoWebSocket</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>Instance of <code><a href="../Classes/VertoWebSocket.html">VertoWebSocket</a></code> to communicate with <code>Verto</code> protocol.</p>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">vertoWebSocket</span><span class="p">:</span> <span class="kt"><a href="../Classes/VertoWebSocket.html">VertoWebSocket</a></span><span class="p">?</span></code></pre>

                        </div>
                      </div>
                    </section>
                  </div>
                </li>
              </ul>
            </div>
            <div class="task-group">
              <div class="task-name-container">
                <a name="/Vars"></a>
                <a name="//apple_ref/swift/Section/Vars" class="dashAnchor"></a>
                <div class="section-name-container">
                  <a class="section-name-link" href="#/Vars"></a>
                  <h3 class="section-name"><p>Vars</p>
</h3>
                </div>
              </div>
              <ul>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:7ZiwoSDK0A6ClientC8delegateAA0aC8Delegate_pSgvp"></a>
                    <a name="//apple_ref/swift/Property/delegate" class="dashAnchor"></a>
                    <a class="token" href="#/s:7ZiwoSDK0A6ClientC8delegateAA0aC8Delegate_pSgvp">delegate</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p><code><a href="../Protocols/ZiwoClientDelegate.html">ZiwoClientDelegate</a></code> protocol will both notify about websocket connections state and call events.</p>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">delegate</span><span class="p">:</span> <span class="kt"><a href="../Protocols/ZiwoClientDelegate.html">ZiwoClientDelegate</a></span><span class="p">?</span></code></pre>

                        </div>
                      </div>
                    </section>
                  </div>
                </li>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:7ZiwoSDK0A6ClientC5callsSayAA4CallCGvp"></a>
                    <a name="//apple_ref/swift/Property/calls" class="dashAnchor"></a>
                    <a class="token" href="#/s:7ZiwoSDK0A6ClientC5callsSayAA4CallCGvp">calls</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>List of actives calls.</p>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">calls</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Classes/Call.html">Call</a></span><span class="p">]</span></code></pre>

                        </div>
                      </div>
                    </section>
                  </div>
                </li>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:7ZiwoSDK0A6ClientC10vertoDebugSbvp"></a>
                    <a name="//apple_ref/swift/Property/vertoDebug" class="dashAnchor"></a>
                    <a class="token" href="#/s:7ZiwoSDK0A6ClientC10vertoDebugSbvp">vertoDebug</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>Boolean that define whether the debug logs of Verto websocket has to be displayed in console or not.</p>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">vertoDebug</span><span class="p">:</span> <span class="kt">Bool</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>

                        </div>
                      </div>
                    </section>
                  </div>
                </li>
              </ul>
            </div>
            <div class="task-group">
              <div class="task-name-container">
                <a name="/Initialization%20Methods"></a>
                <a name="//apple_ref/swift/Section/Initialization Methods" class="dashAnchor"></a>
                <div class="section-name-container">
                  <a class="section-name-link" href="#/Initialization%20Methods"></a>
                  <h3 class="section-name"><p>Initialization Methods</p>
</h3>
                </div>
              </div>
              <ul>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:7ZiwoSDK0A6ClientCACycfc"></a>
                    <a name="//apple_ref/swift/Method/init()" class="dashAnchor"></a>
                    <a class="token" href="#/s:7ZiwoSDK0A6ClientCACycfc">init()</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>Public <code>ZiwoClient</code> initilizer.</p>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="nf">init</span><span class="p">()</span></code></pre>

                        </div>
                      </div>
                    </section>
                  </div>
                </li>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:7ZiwoSDK0A6ClientC010initializeC0yyF"></a>
                    <a name="//apple_ref/swift/Method/initializeClient()" class="dashAnchor"></a>
                    <a class="token" href="#/s:7ZiwoSDK0A6ClientC010initializeC0yyF">initializeClient()</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>Method that initialize and configure the Ziwo client.</p>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">initializeClient</span><span class="p">()</span></code></pre>

                        </div>
                      </div>
                    </section>
                  </div>
                </li>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:7ZiwoSDK0A6ClientC24initializeVertoWebSocket33_252549CC35FDF2F7BD72F1D2AFD6A330LLyyF"></a>
                    <a name="//apple_ref/swift/Method/initializeVertoWebSocket()" class="dashAnchor"></a>
                    <a class="token" href="#/s:7ZiwoSDK0A6ClientC24initializeVertoWebSocket33_252549CC35FDF2F7BD72F1D2AFD6A330LLyyF">initializeVertoWebSocket()</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>Private method that instanciate <code><a href="../Classes/VertoWebSocket.html">VertoWebSocket</a></code> and connect it to the correct endpoint based on the Ziwo domain.</p>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">private</span> <span class="kd">func</span> <span class="nf">initializeVertoWebSocket</span><span class="p">()</span></code></pre>

                        </div>
                      </div>
                    </section>
                  </div>
                </li>
              </ul>
            </div>
            <div class="task-group">
              <div class="task-name-container">
                <a name="/Client%20Call%20Methods"></a>
                <a name="//apple_ref/swift/Section/Client Call Methods" class="dashAnchor"></a>
                <div class="section-name-container">
                  <a class="section-name-link" href="#/Client%20Call%20Methods"></a>
                  <h3 class="section-name"><p>Client Call Methods</p>
</h3>
                </div>
              </div>
              <ul>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:7ZiwoSDK0A6ClientC4call6numberySS_tF"></a>
                    <a name="//apple_ref/swift/Method/call(number:)" class="dashAnchor"></a>
                    <a class="token" href="#/s:7ZiwoSDK0A6ClientC4call6numberySS_tF">call(number:<wbr>)</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>Call an agent or an external number (has to be in international format).
Automatically instantiate a call and setup a RTC connection, create an offer then format a JSON RPC to communicate with Verto protocol.</p>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">call</span><span class="p">(</span><span class="nv">number</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span></code></pre>

                        </div>
                      </div>
                      <div>
                        <h4>Parameters</h4>
                        <table class="graybox">
                          <tbody>
                            <tr>
                              <td>
                                <code>
                                <em>number</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>Number to call</p>
                                </div>
                              </td>
                            </tr>
                          </tbody>
                        </table>
                      </div>
                    </section>
                  </div>
                </li>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:7ZiwoSDK0A6ClientC6hangUp6callIDySS_tF"></a>
                    <a name="//apple_ref/swift/Method/hangUp(callID:)" class="dashAnchor"></a>
                    <a class="token" href="#/s:7ZiwoSDK0A6ClientC6hangUp6callIDySS_tF">hangUp(callID:<wbr>)</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>Hangup a call.</p>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">hangUp</span><span class="p">(</span><span class="nv">callID</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span></code></pre>

                        </div>
                      </div>
                      <div>
                        <h4>Parameters</h4>
                        <table class="graybox">
                          <tbody>
                            <tr>
                              <td>
                                <code>
                                <em>callID</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>ID of the call to hangup</p>
                                </div>
                              </td>
                            </tr>
                          </tbody>
                        </table>
                      </div>
                    </section>
                  </div>
                </li>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:7ZiwoSDK0A6ClientC18answerIncomingCall6callIDySS_tF"></a>
                    <a name="//apple_ref/swift/Method/answerIncomingCall(callID:)" class="dashAnchor"></a>
                    <a class="token" href="#/s:7ZiwoSDK0A6ClientC18answerIncomingCall6callIDySS_tF">answerIncomingCall(callID:<wbr>)</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>Answer an incoming call.</p>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">answerIncomingCall</span><span class="p">(</span><span class="nv">callID</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span></code></pre>

                        </div>
                      </div>
                      <div>
                        <h4>Parameters</h4>
                        <table class="graybox">
                          <tbody>
                            <tr>
                              <td>
                                <code>
                                <em>callID</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>ID of the call to hangup</p>
                                </div>
                              </td>
                            </tr>
                          </tbody>
                        </table>
                      </div>
                    </section>
                  </div>
                </li>
              </ul>
            </div>
            <div class="task-group">
              <div class="task-name-container">
                <a name="/In-Call%20Methods"></a>
                <a name="//apple_ref/swift/Section/In-Call Methods" class="dashAnchor"></a>
                <div class="section-name-container">
                  <a class="section-name-link" href="#/In-Call%20Methods"></a>
                  <h3 class="section-name"><p>In-Call Methods</p>
</h3>
                </div>
              </div>
              <ul>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:7ZiwoSDK0A6ClientC17setSpeakerEnabled6callID_ySS_SbtF"></a>
                    <a name="//apple_ref/swift/Method/setSpeakerEnabled(callID:_:)" class="dashAnchor"></a>
                    <a class="token" href="#/s:7ZiwoSDK0A6ClientC17setSpeakerEnabled6callID_ySS_SbtF">setSpeakerEnabled(callID:<wbr>_:<wbr>)</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>Define the state of the speaker mode (activated / deactivated).</p>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">setSpeakerEnabled</span><span class="p">(</span><span class="nv">callID</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="n">_</span> <span class="nv">value</span><span class="p">:</span> <span class="kt">Bool</span><span class="p">)</span></code></pre>

                        </div>
                      </div>
                      <div>
                        <h4>Parameters</h4>
                        <table class="graybox">
                          <tbody>
                            <tr>
                              <td>
                                <code>
                                <em>callID</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>ID of the call.</p>
                                </div>
                              </td>
                            </tr>
                            <tr>
                              <td>
                                <code>
                                <em>value</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>Boolean that define the state of the speaker mode.</p>
                                </div>
                              </td>
                            </tr>
                          </tbody>
                        </table>
                      </div>
                    </section>
                  </div>
                </li>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:7ZiwoSDK0A6ClientC14setMuteEnabled6callID_ySS_SbtF"></a>
                    <a name="//apple_ref/swift/Method/setMuteEnabled(callID:_:)" class="dashAnchor"></a>
                    <a class="token" href="#/s:7ZiwoSDK0A6ClientC14setMuteEnabled6callID_ySS_SbtF">setMuteEnabled(callID:<wbr>_:<wbr>)</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>Define the state of the microphone (activated / deactivated).</p>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">setMuteEnabled</span><span class="p">(</span><span class="nv">callID</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="n">_</span> <span class="nv">value</span><span class="p">:</span> <span class="kt">Bool</span><span class="p">)</span></code></pre>

                        </div>
                      </div>
                      <div>
                        <h4>Parameters</h4>
                        <table class="graybox">
                          <tbody>
                            <tr>
                              <td>
                                <code>
                                <em>callID</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>ID of the call.</p>
                                </div>
                              </td>
                            </tr>
                            <tr>
                              <td>
                                <code>
                                <em>value</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>Boolean that define the state of the microphone.</p>
                                </div>
                              </td>
                            </tr>
                          </tbody>
                        </table>
                      </div>
                    </section>
                  </div>
                </li>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:7ZiwoSDK0A6ClientC15setPauseEnabled6callID_ySS_SbtF"></a>
                    <a name="//apple_ref/swift/Method/setPauseEnabled(callID:_:)" class="dashAnchor"></a>
                    <a class="token" href="#/s:7ZiwoSDK0A6ClientC15setPauseEnabled6callID_ySS_SbtF">setPauseEnabled(callID:<wbr>_:<wbr>)</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>Method to modify the state of the call to hold or unhold.</p>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">setPauseEnabled</span><span class="p">(</span><span class="nv">callID</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="n">_</span> <span class="nv">value</span><span class="p">:</span> <span class="kt">Bool</span><span class="p">)</span></code></pre>

                        </div>
                      </div>
                      <div>
                        <h4>Parameters</h4>
                        <table class="graybox">
                          <tbody>
                            <tr>
                              <td>
                                <code>
                                <em>callID</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>ID of the call.</p>
                                </div>
                              </td>
                            </tr>
                            <tr>
                              <td>
                                <code>
                                <em>value</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>Boolean that define the state of the call (hold / unhold).</p>
                                </div>
                              </td>
                            </tr>
                          </tbody>
                        </table>
                      </div>
                    </section>
                  </div>
                </li>
              </ul>
            </div>
            <div class="task-group">
              <div class="task-name-container">
                <a name="/Client%20Utils%20Methods"></a>
                <a name="//apple_ref/swift/Section/Client Utils Methods" class="dashAnchor"></a>
                <div class="section-name-container">
                  <a class="section-name-link" href="#/Client%20Utils%20Methods"></a>
                  <h3 class="section-name"><p>Client Utils Methods</p>
</h3>
                </div>
              </div>
              <ul>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:7ZiwoSDK0A6ClientC11isSpeakerOn6callIDSbSS_tF"></a>
                    <a name="//apple_ref/swift/Method/isSpeakerOn(callID:)" class="dashAnchor"></a>
                    <a class="token" href="#/s:7ZiwoSDK0A6ClientC11isSpeakerOn6callIDSbSS_tF">isSpeakerOn(callID:<wbr>)</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>To know if the speaker mode is enabled or not.</p>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">isSpeakerOn</span><span class="p">(</span><span class="nv">callID</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Bool</span></code></pre>

                        </div>
                      </div>
                      <div>
                        <h4>Parameters</h4>
                        <table class="graybox">
                          <tbody>
                            <tr>
                              <td>
                                <code>
                                <em>callID</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>ID of the call.</p>
                                </div>
                              </td>
                            </tr>
                          </tbody>
                        </table>
                      </div>
                      <div>
                        <h4>Return Value</h4>
                        <p>A boolean that defines if the speaker mode is enabled.</p>
                      </div>
                    </section>
                  </div>
                </li>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:7ZiwoSDK0A6ClientC8isPaused6callIDSbSS_tF"></a>
                    <a name="//apple_ref/swift/Method/isPaused(callID:)" class="dashAnchor"></a>
                    <a class="token" href="#/s:7ZiwoSDK0A6ClientC8isPaused6callIDSbSS_tF">isPaused(callID:<wbr>)</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>To know if the call is on hold state.</p>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">isPaused</span><span class="p">(</span><span class="nv">callID</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Bool</span></code></pre>

                        </div>
                      </div>
                      <div>
                        <h4>Parameters</h4>
                        <table class="graybox">
                          <tbody>
                            <tr>
                              <td>
                                <code>
                                <em>callID</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>ID of the call.</p>
                                </div>
                              </td>
                            </tr>
                          </tbody>
                        </table>
                      </div>
                      <div>
                        <h4>Return Value</h4>
                        <p>A boolean that defines if the call is held or not.</p>
                      </div>
                    </section>
                  </div>
                </li>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:7ZiwoSDK0A6ClientC8isMuteOn6callIDSbSS_tF"></a>
                    <a name="//apple_ref/swift/Method/isMuteOn(callID:)" class="dashAnchor"></a>
                    <a class="token" href="#/s:7ZiwoSDK0A6ClientC8isMuteOn6callIDSbSS_tF">isMuteOn(callID:<wbr>)</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>To know if the microphone is muted for this call.</p>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">isMuteOn</span><span class="p">(</span><span class="nv">callID</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Bool</span></code></pre>

                        </div>
                      </div>
                      <div>
                        <h4>Parameters</h4>
                        <table class="graybox">
                          <tbody>
                            <tr>
                              <td>
                                <code>
                                <em>callID</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>ID of the call.</p>
                                </div>
                              </td>
                            </tr>
                          </tbody>
                        </table>
                      </div>
                      <div>
                        <h4>Return Value</h4>
                        <p>A boolean that defines if the microphone is muted.</p>
                      </div>
                    </section>
                  </div>
                </li>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:7ZiwoSDK0A6ClientC8findCall6callIDAA0E0CSgSS_tF"></a>
                    <a name="//apple_ref/swift/Method/findCall(callID:)" class="dashAnchor"></a>
                    <a class="token" href="#/s:7ZiwoSDK0A6ClientC8findCall6callIDAA0E0CSgSS_tF">findCall(callID:<wbr>)</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>Allow user to retrieve a call in the active call list.</p>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">findCall</span><span class="p">(</span><span class="nv">callID</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt"><a href="../Classes/Call.html">Call</a></span><span class="p">?</span></code></pre>

                        </div>
                      </div>
                      <div>
                        <h4>Parameters</h4>
                        <table class="graybox">
                          <tbody>
                            <tr>
                              <td>
                                <code>
                                <em>callID</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>ID of the call.</p>
                                </div>
                              </td>
                            </tr>
                          </tbody>
                        </table>
                      </div>
                      <div>
                        <h4>Return Value</h4>
                        <p>An active call based on its ID.</p>
                      </div>
                    </section>
                  </div>
                </li>
              </ul>
            </div>
            <div class="task-group">
              <div class="task-name-container">
                <a name="/Verto%20Web%20Socket%20Related"></a>
                <a name="//apple_ref/swift/Section/Verto Web Socket Related" class="dashAnchor"></a>
                <div class="section-name-container">
                  <a class="section-name-link" href="#/Verto%20Web%20Socket%20Related"></a>
                  <h3 class="section-name"><p>Verto Web Socket Related</p>
</h3>
                </div>
              </div>
              <ul>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:7ZiwoSDK22VertoWebSocketDelegateP02wsC9ConnectedyyF"></a>
                    <a name="//apple_ref/swift/Method/wsVertoConnected()" class="dashAnchor"></a>
                    <a class="token" href="#/s:7ZiwoSDK22VertoWebSocketDelegateP02wsC9ConnectedyyF">wsVertoConnected()</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        
                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">wsVertoConnected</span><span class="p">()</span></code></pre>

                        </div>
                      </div>
                    </section>
                  </div>
                </li>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:7ZiwoSDK22VertoWebSocketDelegateP02wsC12DisconnectedyyF"></a>
                    <a name="//apple_ref/swift/Method/wsVertoDisconnected()" class="dashAnchor"></a>
                    <a class="token" href="#/s:7ZiwoSDK22VertoWebSocketDelegateP02wsC12DisconnectedyyF">wsVertoDisconnected()</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        
                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">wsVertoDisconnected</span><span class="p">()</span></code></pre>

                        </div>
                      </div>
                    </section>
                  </div>
                </li>
              </ul>
            </div>
            <div class="task-group">
              <div class="task-name-container">
                <a name="/Verto%20Protocol%20Related"></a>
                <a name="//apple_ref/swift/Section/Verto Protocol Related" class="dashAnchor"></a>
                <div class="section-name-container">
                  <a class="section-name-link" href="#/Verto%20Protocol%20Related"></a>
                  <h3 class="section-name"><p>Verto Protocol Related</p>
</h3>
                </div>
              </div>
              <ul>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:7ZiwoSDK22VertoWebSocketDelegateP16vertoClientReadyyyF"></a>
                    <a name="//apple_ref/swift/Method/vertoClientReady()" class="dashAnchor"></a>
                    <a class="token" href="#/s:7ZiwoSDK22VertoWebSocketDelegateP16vertoClientReadyyyF">vertoClientReady()</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        
                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">vertoClientReady</span><span class="p">()</span></code></pre>

                        </div>
                      </div>
                    </section>
                  </div>
                </li>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:7ZiwoSDK22VertoWebSocketDelegateP16vertoCallStarted6callID3sdpySS_SStF"></a>
                    <a name="//apple_ref/swift/Method/vertoCallStarted(callID:sdp:)" class="dashAnchor"></a>
                    <a class="token" href="#/s:7ZiwoSDK22VertoWebSocketDelegateP16vertoCallStarted6callID3sdpySS_SStF">vertoCallStarted(callID:<wbr>sdp:<wbr>)</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        
                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">vertoCallStarted</span><span class="p">(</span><span class="nv">callID</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">sdp</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span></code></pre>

                        </div>
                      </div>
                    </section>
                  </div>
                </li>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:7ZiwoSDK22VertoWebSocketDelegateP18vertoAnsweringCall6callID10callerName3sdpySS_S2StF"></a>
                    <a name="//apple_ref/swift/Method/vertoAnsweringCall(callID:callerName:sdp:)" class="dashAnchor"></a>
                    <a class="token" href="#/s:7ZiwoSDK22VertoWebSocketDelegateP18vertoAnsweringCall6callID10callerName3sdpySS_S2StF">vertoAnsweringCall(callID:<wbr>callerName:<wbr>sdp:<wbr>)</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        
                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">vertoAnsweringCall</span><span class="p">(</span><span class="nv">callID</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">callerName</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">sdp</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span></code></pre>

                        </div>
                      </div>
                    </section>
                  </div>
                </li>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:7ZiwoSDK22VertoWebSocketDelegateP16vertoCallDisplayyyF"></a>
                    <a name="//apple_ref/swift/Method/vertoCallDisplay()" class="dashAnchor"></a>
                    <a class="token" href="#/s:7ZiwoSDK22VertoWebSocketDelegateP16vertoCallDisplayyyF">vertoCallDisplay()</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        
                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">vertoCallDisplay</span><span class="p">()</span></code></pre>

                        </div>
                      </div>
                    </section>
                  </div>
                </li>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:7ZiwoSDK22VertoWebSocketDelegateP14vertoCallEnded6callIDySS_tF"></a>
                    <a name="//apple_ref/swift/Method/vertoCallEnded(callID:)" class="dashAnchor"></a>
                    <a class="token" href="#/s:7ZiwoSDK22VertoWebSocketDelegateP14vertoCallEnded6callIDySS_tF">vertoCallEnded(callID:<wbr>)</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        
                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">vertoCallEnded</span><span class="p">(</span><span class="nv">callID</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span></code></pre>

                        </div>
                      </div>
                    </section>
                  </div>
                </li>
              </ul>
            </div>
          </section>
        </section>
        <section id="footer">
          <p>&copy; 2020 <a class="link" href="https://github.com/ASWATFZLLC/ziwo-sdk-ios" target="_blank" rel="external">Emilien Roussel</a>. All rights reserved. (Last updated: 2020-05-14)</p>
          <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
        </section>
      </article>
    </div>
  </body>
</div>
</html>
